Filter hook 'update_{$meta_type}_metadata'

in WP Core File wp-includes/meta.php at line 235

Description

Short-circuits updating metadata of a specific type. The dynamic portion of the hook name, `$meta_type`, refers to the meta object type (post, comment, term, user, or any other type with an associated meta table). Returning a non-null value will effectively short-circuit the function. Possible hook names include: - `update_post_metadata` - `update_comment_metadata` - `update_term_metadata` - `update_user_metadata`

Occurrences

Filename Line Number
wp-includes/meta.php 235

Parameters

Type Name Description
null|bool $check Whether to allow updating metadata for the given type.
int $object_id ID of the object metadata is for.
string $meta_key Metadata key.
mixed $meta_value Metadata value. Must be serializable if non-scalar.
mixed $prev_value Optional. Previous value to check before updating. If specified, only update existing metadata entries with this value. Otherwise, update all entries.

PHP Doc

/**
	 * Short-circuits updating metadata of a specific type.
	 *
	 * The dynamic portion of the hook name, `$meta_type`, refers to the meta object type
	 * (post, comment, term, user, or any other type with an associated meta table).
	 * Returning a non-null value will effectively short-circuit the function.
	 *
	 * Possible hook names include:
	 *
	 *  - `update_post_metadata`
	 *  - `update_comment_metadata`
	 *  - `update_term_metadata`
	 *  - `update_user_metadata`
	 *
	 * @since 3.1.0
	 *
	 * @param null|bool $check      Whether to allow updating metadata for the given type.
	 * @param int       $object_id  ID of the object metadata is for.
	 * @param string    $meta_key   Metadata key.
	 * @param mixed     $meta_value Metadata value. Must be serializable if non-scalar.
	 * @param mixed     $prev_value Optional. Previous value to check before updating.
	 *                              If specified, only update existing metadata entries with
	 *                              this value. Otherwise, update all entries.
	 */